Group endpoints
AddGroup
AddGroup(System.String,System.String,System.String)
Add a group to the account
Parameters
Param: groupName: Group Name
Param: description: Group Description
Param: organization: Account
Returns
True if added
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
AddUsersToGroup
AddUsersToGroup(System.Collections.Generic.List{System.String},System.String,System.String)
User becomes a member of the group. Group membership is explicit by name. Read only or writable does not matter.
Parameters
Param: userNames: Names of users to add to group
Param: groupName: Name of group to add users to
Param: organization: Account
Returns
True if users are members
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
GetGroups
GetGroups(System.String,DataLayer.Entity.GroupKind)
Get a list of the groups in the account.
Parameters
Param: organization: Account
Param: kind: Read Only, Writable or Both
Returns
A table with the following columns:
-
Groupname
-
Groupdescription
-
removable
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
RemoveGroup
RemoveGroup(System.String,System.String)
Remove a writable group from the account.
Parameters
Param: groupName: Name of group to remove
Param: organization: Account
Returns
True if removed
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
RemoveUserFromGroup
RemoveUserFromGroup(System.Collections.Generic.List{System.String},System.String,System.String)
Removes users group membership.
Parameters
Param: userNames: Users to remove from the group
Param: groupName: Group name to remove membership from
Param: organization: Account
Returns
True if users have their membership removed
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
UpdateGroup
UpdateGroup(System.String,System.String,System.String,System.String)
Update a group in the account. Applies to writable groups only.
Parameters
Param: groupName: Name of the group as it exists
Param: newName: New name of the group
Param: newDescription: New description of the group
Param: organization: Account
Returns
True if updated
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response: